/status/system/interface/<intf_name>/ip/dhcp/state¶
Use
If DHCP is enabled, use to see the state of the DHCP-assigned IP address.
Parameters¶
intf_name: Name of interface object
Data Key¶
The data key contains one of the values listed in Data Values below.
Data Type¶
string
Data Values¶
Below are the possible values for the state field or node:
- disabled - DHCP not enabled.
- starting - DHCP enabled, dhclient not yet started.
- requesting - dhclient has been started or restarted.
- enabled - DHCP lease has been acquired.
- expired - DHCP lease has expired and attempts to renew have failed.
- no server - Unable to contact a DHCP server.
Default Data Value¶
“”
Request Methods¶
GET
Examples¶
GET
curl -b cookie.jar -k https://10.1.2.3:8443/lrs/api/v1.0/status/system/interface/em1/ip/dhcp/state
GET Response
{"/status/system/interface/em1/ip/dhcp/state": {"data": "disabled",
"default": False,
"defaultAllowed": True,
"deleteAllowed": False,
"numChildren": 0,
"type": "string"},
"httpResponseCode": 200,
"recurse": False,
"requestPath": "/status/system/interface/em1/ip/dhcp/state"}
- /status/system/interface/<intf_name>/ip/dhcp/state
1. Parameters
2. Data Key
- Data Type
- Data Values
- Default Data Value 3. Request Methods 4. Related 5. Examples